/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache license, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.internna.iwebjtracker.server.connection;

/**
 *
 * @author Jose Noheda
 * @since 1.0
 */
public interface ServerConnection {

    /**
     * Determines if this connection is open
     */
    boolean isOpen();

    /**
     * Determines if this connection should be closed once is opened.
     */
    boolean isClosable();

    /**
     * Determines if the server should attempt to keep this connection open even if no data is being transmitted.
     */
    boolean keepAlive();

    /**
     * Max number of seconds that the server will try to keep this connection alive if no data is trsnferred.
     *
     * @return -1 will be interpreted as an eternal connection. Otherwise a positive integer.
     */
    int keepAliveTimeout();

    /**
     * Closes the connection. No other requests will be accepted.
     */
    void close();

}
